<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.util;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Collection;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.concurrent.CopyOnWriteArrayList;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.math3.exception.MaxCountExceededException;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    /**<a name="line.24"></a>
<FONT color="green">025</FONT>     * This abstract class provides a general framework for managing iterative<a name="line.25"></a>
<FONT color="green">026</FONT>     * algorithms. The maximum number of iterations can be set, and methods are<a name="line.26"></a>
<FONT color="green">027</FONT>     * provided to monitor the current iteration count. A lightweight event<a name="line.27"></a>
<FONT color="green">028</FONT>     * framework is also provided.<a name="line.28"></a>
<FONT color="green">029</FONT>     *<a name="line.29"></a>
<FONT color="green">030</FONT>     * @version $Id: IterationManager.java 1422313 2012-12-15 18:53:41Z psteitz $<a name="line.30"></a>
<FONT color="green">031</FONT>     */<a name="line.31"></a>
<FONT color="green">032</FONT>    public class IterationManager {<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>        /** Keeps a count of the number of iterations. */<a name="line.34"></a>
<FONT color="green">035</FONT>        private final Incrementor iterations;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>        /** The collection of all listeners attached to this iterative algorithm. */<a name="line.37"></a>
<FONT color="green">038</FONT>        private final Collection&lt;IterationListener&gt; listeners;<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>        /**<a name="line.40"></a>
<FONT color="green">041</FONT>         * Creates a new instance of this class.<a name="line.41"></a>
<FONT color="green">042</FONT>         *<a name="line.42"></a>
<FONT color="green">043</FONT>         * @param maxIterations the maximum number of iterations<a name="line.43"></a>
<FONT color="green">044</FONT>         */<a name="line.44"></a>
<FONT color="green">045</FONT>        public IterationManager(final int maxIterations) {<a name="line.45"></a>
<FONT color="green">046</FONT>            this.iterations = new Incrementor(maxIterations);<a name="line.46"></a>
<FONT color="green">047</FONT>            this.listeners = new CopyOnWriteArrayList&lt;IterationListener&gt;();<a name="line.47"></a>
<FONT color="green">048</FONT>        }<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        /**<a name="line.50"></a>
<FONT color="green">051</FONT>         * Creates a new instance of this class.<a name="line.51"></a>
<FONT color="green">052</FONT>         *<a name="line.52"></a>
<FONT color="green">053</FONT>         * @param maxIterations the maximum number of iterations<a name="line.53"></a>
<FONT color="green">054</FONT>         * @param callBack the function to be called when the maximum number of<a name="line.54"></a>
<FONT color="green">055</FONT>         * iterations has been reached<a name="line.55"></a>
<FONT color="green">056</FONT>         * @throws org.apache.commons.math3.exception.NullArgumentException if {@code callBack} is {@code null}<a name="line.56"></a>
<FONT color="green">057</FONT>         * @since 3.1<a name="line.57"></a>
<FONT color="green">058</FONT>         */<a name="line.58"></a>
<FONT color="green">059</FONT>        public IterationManager(final int maxIterations,<a name="line.59"></a>
<FONT color="green">060</FONT>                                final Incrementor.MaxCountExceededCallback callBack) {<a name="line.60"></a>
<FONT color="green">061</FONT>            this.iterations = new Incrementor(maxIterations, callBack);<a name="line.61"></a>
<FONT color="green">062</FONT>            this.listeners = new CopyOnWriteArrayList&lt;IterationListener&gt;();<a name="line.62"></a>
<FONT color="green">063</FONT>        }<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>        /**<a name="line.65"></a>
<FONT color="green">066</FONT>         * Attaches a listener to this manager.<a name="line.66"></a>
<FONT color="green">067</FONT>         *<a name="line.67"></a>
<FONT color="green">068</FONT>         * @param listener A {@code IterationListener} object.<a name="line.68"></a>
<FONT color="green">069</FONT>         */<a name="line.69"></a>
<FONT color="green">070</FONT>        public void addIterationListener(final IterationListener listener) {<a name="line.70"></a>
<FONT color="green">071</FONT>            listeners.add(listener);<a name="line.71"></a>
<FONT color="green">072</FONT>        }<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>        /**<a name="line.74"></a>
<FONT color="green">075</FONT>         * Informs all registered listeners that the initial phase (prior to the<a name="line.75"></a>
<FONT color="green">076</FONT>         * main iteration loop) has been completed.<a name="line.76"></a>
<FONT color="green">077</FONT>         *<a name="line.77"></a>
<FONT color="green">078</FONT>         * @param e The {@link IterationEvent} object.<a name="line.78"></a>
<FONT color="green">079</FONT>         */<a name="line.79"></a>
<FONT color="green">080</FONT>        public void fireInitializationEvent(final IterationEvent e) {<a name="line.80"></a>
<FONT color="green">081</FONT>            for (IterationListener l : listeners) {<a name="line.81"></a>
<FONT color="green">082</FONT>                l.initializationPerformed(e);<a name="line.82"></a>
<FONT color="green">083</FONT>            }<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>        /**<a name="line.86"></a>
<FONT color="green">087</FONT>         * Informs all registered listeners that a new iteration (in the main<a name="line.87"></a>
<FONT color="green">088</FONT>         * iteration loop) has been performed.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @param e The {@link IterationEvent} object.<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        public void fireIterationPerformedEvent(final IterationEvent e) {<a name="line.92"></a>
<FONT color="green">093</FONT>            for (IterationListener l : listeners) {<a name="line.93"></a>
<FONT color="green">094</FONT>                l.iterationPerformed(e);<a name="line.94"></a>
<FONT color="green">095</FONT>            }<a name="line.95"></a>
<FONT color="green">096</FONT>        }<a name="line.96"></a>
<FONT color="green">097</FONT>    <a name="line.97"></a>
<FONT color="green">098</FONT>        /**<a name="line.98"></a>
<FONT color="green">099</FONT>         * Informs all registered listeners that a new iteration (in the main<a name="line.99"></a>
<FONT color="green">100</FONT>         * iteration loop) has been started.<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param e The {@link IterationEvent} object.<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        public void fireIterationStartedEvent(final IterationEvent e) {<a name="line.104"></a>
<FONT color="green">105</FONT>            for (IterationListener l : listeners) {<a name="line.105"></a>
<FONT color="green">106</FONT>                l.iterationStarted(e);<a name="line.106"></a>
<FONT color="green">107</FONT>            }<a name="line.107"></a>
<FONT color="green">108</FONT>        }<a name="line.108"></a>
<FONT color="green">109</FONT>    <a name="line.109"></a>
<FONT color="green">110</FONT>        /**<a name="line.110"></a>
<FONT color="green">111</FONT>         * Informs all registered listeners that the final phase (post-iterations)<a name="line.111"></a>
<FONT color="green">112</FONT>         * has been completed.<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * @param e The {@link IterationEvent} object.<a name="line.114"></a>
<FONT color="green">115</FONT>         */<a name="line.115"></a>
<FONT color="green">116</FONT>        public void fireTerminationEvent(final IterationEvent e) {<a name="line.116"></a>
<FONT color="green">117</FONT>            for (IterationListener l : listeners) {<a name="line.117"></a>
<FONT color="green">118</FONT>                l.terminationPerformed(e);<a name="line.118"></a>
<FONT color="green">119</FONT>            }<a name="line.119"></a>
<FONT color="green">120</FONT>        }<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>        /**<a name="line.122"></a>
<FONT color="green">123</FONT>         * Returns the number of iterations of this solver, 0 if no iterations has<a name="line.123"></a>
<FONT color="green">124</FONT>         * been performed yet.<a name="line.124"></a>
<FONT color="green">125</FONT>         *<a name="line.125"></a>
<FONT color="green">126</FONT>         * @return the number of iterations.<a name="line.126"></a>
<FONT color="green">127</FONT>         */<a name="line.127"></a>
<FONT color="green">128</FONT>        public int getIterations() {<a name="line.128"></a>
<FONT color="green">129</FONT>            return iterations.getCount();<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>        /**<a name="line.132"></a>
<FONT color="green">133</FONT>         * Returns the maximum number of iterations.<a name="line.133"></a>
<FONT color="green">134</FONT>         *<a name="line.134"></a>
<FONT color="green">135</FONT>         * @return the maximum number of iterations.<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        public int getMaxIterations() {<a name="line.137"></a>
<FONT color="green">138</FONT>            return iterations.getMaximalCount();<a name="line.138"></a>
<FONT color="green">139</FONT>        }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        /**<a name="line.141"></a>
<FONT color="green">142</FONT>         * Increments the iteration count by one, and throws an exception if the<a name="line.142"></a>
<FONT color="green">143</FONT>         * maximum number of iterations is reached. This method should be called at<a name="line.143"></a>
<FONT color="green">144</FONT>         * the beginning of a new iteration.<a name="line.144"></a>
<FONT color="green">145</FONT>         *<a name="line.145"></a>
<FONT color="green">146</FONT>         * @throws MaxCountExceededException if the maximum number of iterations is<a name="line.146"></a>
<FONT color="green">147</FONT>         * reached.<a name="line.147"></a>
<FONT color="green">148</FONT>         */<a name="line.148"></a>
<FONT color="green">149</FONT>        public void incrementIterationCount()<a name="line.149"></a>
<FONT color="green">150</FONT>            throws MaxCountExceededException {<a name="line.150"></a>
<FONT color="green">151</FONT>            iterations.incrementCount();<a name="line.151"></a>
<FONT color="green">152</FONT>        }<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>        /**<a name="line.154"></a>
<FONT color="green">155</FONT>         * Removes the specified iteration listener from the list of listeners<a name="line.155"></a>
<FONT color="green">156</FONT>         * currently attached to {@code this} object. Attempting to remove a<a name="line.156"></a>
<FONT color="green">157</FONT>         * listener which was &lt;em&gt;not&lt;/em&gt; previously registered does not cause any<a name="line.157"></a>
<FONT color="green">158</FONT>         * error.<a name="line.158"></a>
<FONT color="green">159</FONT>         *<a name="line.159"></a>
<FONT color="green">160</FONT>         * @param listener The {@link IterationListener} to be removed.<a name="line.160"></a>
<FONT color="green">161</FONT>         */<a name="line.161"></a>
<FONT color="green">162</FONT>        public void removeIterationListener(final IterationListener listener) {<a name="line.162"></a>
<FONT color="green">163</FONT>            listeners.remove(listener);<a name="line.163"></a>
<FONT color="green">164</FONT>        }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>        /**<a name="line.166"></a>
<FONT color="green">167</FONT>         * Sets the iteration count to 0. This method must be called during the<a name="line.167"></a>
<FONT color="green">168</FONT>         * initial phase.<a name="line.168"></a>
<FONT color="green">169</FONT>         */<a name="line.169"></a>
<FONT color="green">170</FONT>        public void resetIterationCount() {<a name="line.170"></a>
<FONT color="green">171</FONT>            iterations.resetCount();<a name="line.171"></a>
<FONT color="green">172</FONT>        }<a name="line.172"></a>
<FONT color="green">173</FONT>    }<a name="line.173"></a>




























































</PRE>
</BODY>
</HTML>
